Description
Set a single property value on the input document. The property is specified using its xpath. Save parameter automatically saves the document in the database. It has to be turned off when this operation is used in the context of the empty document created, about to create, before document modification, document modified events. Returns the modified document.
| Operation id | Document.SetProperty |
|---|
| Category | Document |
|---|
| Label | Update Property |
|---|
| Requires | |
|---|
| Since | |
|---|
Parameters
Signature
| Inputs | document, documents |
|---|
| Outputs | document, documents |
|---|
Implementation Information
JSON Definition
{
"id" : "Document.SetProperty",
"label" : "Update Property",
"category" : "Document",
"requires" : null,
"description" : "Set a single property value on the input document. The property is specified using its xpath. Save parameter automatically saves the document in the database. It has to be turned off when this operation is used in the context of the empty document created, about to create, before document modification, document modified events. Returns the modified document.",
"url" : "Document.SetProperty",
"signature" : [ "document", "document", "documents", "documents" ],
"params" : [ {
"name" : "xpath",
"description" : null,
"type" : "string",
"required" : true,
"widget" : null,
"order" : 0,
"values" : [ ]
}, {
"name" : "save",
"description" : null,
"type" : "boolean",
"required" : false,
"widget" : null,
"order" : 0,
"values" : [ "true" ]
}, {
"name" : "value",
"description" : null,
"type" : "serializable",
"required" : false,
"widget" : null,
"order" : 0,
"values" : [ ]
} ]
}